home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 2002 November / CD 1 / APC0211D1.ISO / workshop / prog / files / ActivePerl-5.6.1.633-MSWin32.msi / _d2685d09549ff652f544ed151f626078 < prev    next >
Encoding:
Text File  |  2002-06-17  |  48.4 KB  |  1,860 lines
  1. @rem = '--*-Perl-*--
  2. @echo off
  3. if "%OS%" == "Windows_NT" goto WinNT
  4. perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
  5. goto endofperl
  6. :WinNT
  7. perl -x -S %0 %*
  8. if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
  9. if %errorlevel% == 9009 echo You do not have Perl in your PATH.
  10. if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
  11. goto endofperl
  12. @rem ';
  13. #!perl
  14. #line 15
  15.     eval 'exec C:\p4view\Apps\ActivePerl\MSI\data\ActivePerl\Perl\bin\perl.exe -S $0 ${1+"$@"}'
  16.     if $running_under_some_shell;
  17.  
  18. =head1 NAME
  19.  
  20. h2xs - convert .h C header files to Perl extensions
  21.  
  22. =head1 SYNOPSIS
  23.  
  24. B<h2xs> [B<-ACOPXacdfkmx>] [B<-F> addflags] [B<-M> fmask] [B<-n> module_name] [B<-o> tmask] [B<-p> prefix] [B<-s> subs] [B<-v> version] [headerfile ... [extra_libraries]]
  25.  
  26. B<h2xs> B<-h>
  27.  
  28. =head1 DESCRIPTION
  29.  
  30. I<h2xs> builds a Perl extension from C header files.  The extension
  31. will include functions which can be used to retrieve the value of any
  32. #define statement which was in the C header files.
  33.  
  34. The I<module_name> will be used for the name of the extension.  If
  35. module_name is not supplied then the name of the first header file
  36. will be used, with the first character capitalized.
  37.  
  38. If the extension might need extra libraries, they should be included
  39. here.  The extension Makefile.PL will take care of checking whether
  40. the libraries actually exist and how they should be loaded.
  41. The extra libraries should be specified in the form -lm -lposix, etc,
  42. just as on the cc command line.  By default, the Makefile.PL will
  43. search through the library path determined by Configure.  That path
  44. can be augmented by including arguments of the form B<-L/another/library/path>
  45. in the extra-libraries argument.
  46.  
  47. =head1 OPTIONS
  48.  
  49. =over 5
  50.  
  51. =item B<-A>
  52.  
  53. Omit all autoload facilities.  This is the same as B<-c> but also removes the
  54. S<C<use AutoLoader>> statement from the .pm file.
  55.  
  56. =item B<-C>
  57.  
  58. Omits creation of the F<Changes> file, and adds a HISTORY section to
  59. the POD template.
  60.  
  61. =item B<-F> I<addflags>
  62.  
  63. Additional flags to specify to C preprocessor when scanning header for
  64. function declarations.  Should not be used without B<-x>.
  65.  
  66. =item B<-M> I<regular expression>
  67.  
  68. selects functions/macros to process.
  69.  
  70. =item B<-O>
  71.  
  72. Allows a pre-existing extension directory to be overwritten.
  73.  
  74. =item B<-P>
  75.  
  76. Omit the autogenerated stub POD section. 
  77.  
  78. =item B<-X>
  79.  
  80. Omit the XS portion.  Used to generate templates for a module which is not
  81. XS-based.  C<-c> and C<-f> are implicitly enabled.
  82.  
  83. =item B<-a>
  84.  
  85. Generate an accessor method for each element of structs and unions. The
  86. generated methods are named after the element name; will return the current
  87. value of the element if called without additional arguments; and will set
  88. the element to the supplied value (and return the new value) if called with
  89. an additional argument. Embedded structures and unions are returned as a
  90. pointer rather than the complete structure, to facilitate chained calls.
  91.  
  92. These methods all apply to the Ptr type for the structure; additionally
  93. two methods are constructed for the structure type itself, C<_to_ptr>
  94. which returns a Ptr type pointing to the same structure, and a C<new>
  95. method to construct and return a new structure, initialised to zeroes.
  96.  
  97. =item B<-c>
  98.  
  99. Omit C<constant()> from the .xs file and corresponding specialised
  100. C<AUTOLOAD> from the .pm file.
  101.  
  102. =item B<-d>
  103.  
  104. Turn on debugging messages.
  105.  
  106. =item B<-f>
  107.  
  108. Allows an extension to be created for a header even if that header is
  109. not found in standard include directories.
  110.  
  111. =item B<-h>
  112.  
  113. Print the usage, help and version for this h2xs and exit.
  114.  
  115. =item B<-k>
  116.  
  117. For function arguments declared as C<const>, omit the const attribute in the
  118. generated XS code.
  119.  
  120. =item B<-m>
  121.  
  122. B<Experimental>: for each variable declared in the header file(s), declare
  123. a perl variable of the same name magically tied to the C variable.
  124.  
  125. =item B<-n> I<module_name>
  126.  
  127. Specifies a name to be used for the extension, e.g., S<-n RPC::DCE>
  128.  
  129. =item B<-o> I<regular expression>
  130.  
  131. Use "opaque" data type for the C types matched by the regular
  132. expression, even if these types are C<typedef>-equivalent to types
  133. from typemaps.  Should not be used without B<-x>.
  134.  
  135. This may be useful since, say, types which are C<typedef>-equivalent
  136. to integers may represent OS-related handles, and one may want to work
  137. with these handles in OO-way, as in C<$handle-E<gt>do_something()>.
  138. Use C<-o .> if you want to handle all the C<typedef>ed types as opaque types.
  139.  
  140. The type-to-match is whitewashed (except for commas, which have no
  141. whitespace before them, and multiple C<*> which have no whitespace
  142. between them).
  143.  
  144. =item B<-p> I<prefix>
  145.  
  146. Specify a prefix which should be removed from the Perl function names, e.g., S<-p sec_rgy_> 
  147. This sets up the XS B<PREFIX> keyword and removes the prefix from functions that are
  148. autoloaded via the C<constant()> mechanism.
  149.  
  150. =item B<-s> I<sub1,sub2>
  151.  
  152. Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine.
  153. These macros are assumed to have a return type of B<char *>, e.g., S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>.
  154.  
  155. =item B<-v> I<version>
  156.  
  157. Specify a version number for this extension.  This version number is added
  158. to the templates.  The default is 0.01.
  159.  
  160. =item B<-x>
  161.  
  162. Automatically generate XSUBs basing on function declarations in the
  163. header file.  The package C<C::Scan> should be installed. If this
  164. option is specified, the name of the header file may look like
  165. C<NAME1,NAME2>. In this case NAME1 is used instead of the specified string,
  166. but XSUBs are emitted only for the declarations included from file NAME2.
  167.  
  168. Note that some types of arguments/return-values for functions may
  169. result in XSUB-declarations/typemap-entries which need
  170. hand-editing. Such may be objects which cannot be converted from/to a
  171. pointer (like C<long long>), pointers to functions, or arrays.  See
  172. also the section on L<LIMITATIONS of B<-x>>.
  173.  
  174. =item B<-b> I<version>
  175.  
  176. Generates a .pm file which is backwards compatible with the specified
  177. perl version.
  178.  
  179. For versions < 5.6.0, the changes are.
  180.     - no use of 'our' (uses 'use vars' instead)
  181.     - no 'use warnings'
  182.  
  183. Specifying a compatibility version higher than the version of perl you
  184. are using to run h2xs will have no effect.
  185.  
  186. =back
  187.  
  188. =head1 EXAMPLES
  189.  
  190.  
  191.     # Default behavior, extension is Rusers
  192.     h2xs rpcsvc/rusers
  193.  
  194.     # Same, but extension is RUSERS
  195.     h2xs -n RUSERS rpcsvc/rusers
  196.  
  197.     # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h>
  198.     h2xs rpcsvc::rusers
  199.  
  200.     # Extension is ONC::RPC.  Still finds <rpcsvc/rusers.h>
  201.     h2xs -n ONC::RPC rpcsvc/rusers
  202.  
  203.     # Without constant() or AUTOLOAD
  204.     h2xs -c rpcsvc/rusers
  205.  
  206.     # Creates templates for an extension named RPC
  207.     h2xs -cfn RPC
  208.  
  209.     # Extension is ONC::RPC.
  210.     h2xs -cfn ONC::RPC
  211.  
  212.     # Makefile.PL will look for library -lrpc in 
  213.     # additional directory /opt/net/lib
  214.     h2xs rpcsvc/rusers -L/opt/net/lib -lrpc
  215.  
  216.         # Extension is DCE::rgynbase
  217.         # prefix "sec_rgy_" is dropped from perl function names
  218.         h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase
  219.  
  220.         # Extension is DCE::rgynbase
  221.         # prefix "sec_rgy_" is dropped from perl function names
  222.         # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid
  223.         h2xs -n DCE::rgynbase -p sec_rgy_ \
  224.         -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase
  225.  
  226.     # Make XS without defines in perl.h, but with function declarations
  227.     # visible from perl.h. Name of the extension is perl1.
  228.     # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)=
  229.     # Extra backslashes below because the string is passed to shell.
  230.     # Note that a directory with perl header files would 
  231.     #  be added automatically to include path.
  232.     h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h
  233.  
  234.     # Same with function declaration in proto.h as visible from perl.h.
  235.     h2xs -xAn perl2 perl.h,proto.h
  236.  
  237.     # Same but select only functions which match /^av_/
  238.     h2xs -M '^av_' -xAn perl2 perl.h,proto.h
  239.  
  240.     # Same but treat SV* etc as "opaque" types
  241.     h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h
  242.  
  243. =head2 Extension based on F<.h> and F<.c> files
  244.  
  245. Suppose that you have some C files implementing some functionality,
  246. and the corresponding header files.  How to create an extension which
  247. makes this functionality accessable in Perl?  The example below
  248. assumes that the header files are F<interface_simple.h> and
  249. I<interface_hairy.h>, and you want the perl module be named as
  250. C<Ext::Ension>.  If you need some preprocessor directives and/or
  251. linking with external libraries, see the flags C<-F>, C<-L> and C<-l>
  252. in L<"OPTIONS">.
  253.  
  254. =over
  255.  
  256. =item Find the directory name
  257.  
  258. Start with a dummy run of h2xs:
  259.  
  260.   h2xs -Afn Ext::Ension
  261.  
  262. The only purpose of this step is to create the needed directories, and
  263. let you know the names of these directories.  From the output you can
  264. see that the directory for the extension is F<Ext/Ension>.
  265.  
  266. =item Copy C files
  267.  
  268. Copy your header files and C files to this directory F<Ext/Ension>.
  269.  
  270. =item Create the extension
  271.  
  272. Run h2xs, overwriting older autogenerated files:
  273.  
  274.   h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h
  275.  
  276. h2xs looks for header files I<after> changing to the extension
  277. directory, so it will find your header files OK.
  278.  
  279. =item Archive and test
  280.  
  281. As usual, run
  282.  
  283.   cd Ext/Ension
  284.   perl Makefile.PL
  285.   make dist
  286.   make
  287.   make test
  288.  
  289. =item Hints
  290.  
  291. It is important to do C<make dist> as early as possible.  This way you
  292. can easily merge(1) your changes to autogenerated files if you decide
  293. to edit your C<.h> files and rerun h2xs.
  294.  
  295. Do not forget to edit the documentation in the generated F<.pm> file.
  296.  
  297. Consider the autogenerated files as skeletons only, you may invent
  298. better interfaces than what h2xs could guess.
  299.  
  300. Consider this section as a guideline only, some other options of h2xs
  301. may better suit your needs.
  302.  
  303. =back
  304.  
  305. =head1 ENVIRONMENT
  306.  
  307. No environment variables are used.
  308.  
  309. =head1 AUTHOR
  310.  
  311. Larry Wall and others
  312.  
  313. =head1 SEE ALSO
  314.  
  315. L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>.
  316.  
  317. =head1 DIAGNOSTICS
  318.  
  319. The usual warnings if it cannot read or write the files involved.
  320.  
  321. =head1 LIMITATIONS of B<-x>
  322.  
  323. F<h2xs> would not distinguish whether an argument to a C function
  324. which is of the form, say, C<int *>, is an input, output, or
  325. input/output parameter.  In particular, argument declarations of the
  326. form
  327.  
  328.     int
  329.     foo(n)
  330.     int *n
  331.  
  332. should be better rewritten as
  333.  
  334.     int
  335.     foo(n)
  336.     int &n
  337.  
  338. if C<n> is an input parameter.
  339.  
  340. Additionally, F<h2xs> has no facilities to intuit that a function
  341.  
  342.    int
  343.    foo(addr,l)
  344.     char *addr
  345.     int   l
  346.  
  347. takes a pair of address and length of data at this address, so it is better
  348. to rewrite this function as
  349.  
  350.     int
  351.     foo(sv)
  352.         SV *addr
  353.     PREINIT:
  354.         STRLEN len;
  355.         char *s;
  356.     CODE:
  357.         s = SvPV(sv,len);
  358.         RETVAL = foo(s, len);
  359.     OUTPUT:
  360.         RETVAL
  361.  
  362. or alternately
  363.  
  364.     static int
  365.     my_foo(SV *sv)
  366.     {
  367.     STRLEN len;
  368.     char *s = SvPV(sv,len);
  369.  
  370.     return foo(s, len);
  371.     }
  372.  
  373.     MODULE = foo    PACKAGE = foo    PREFIX = my_
  374.  
  375.     int
  376.     foo(sv)
  377.     SV *sv
  378.  
  379. See L<perlxs> and L<perlxstut> for additional details.
  380.  
  381. =cut
  382.  
  383. use strict;
  384.  
  385.  
  386. my( $H2XS_VERSION ) = ' $Revision: 1.21 $ ' =~ /\$Revision:\s+([^\s]+)/;
  387. my $TEMPLATE_VERSION = '0.01';
  388. my @ARGS = @ARGV;
  389. my $compat_version = $];
  390.  
  391. use Getopt::Std;
  392.  
  393. sub usage{
  394.     warn "@_\n" if @_;
  395.     die "h2xs [-ACOPXacdfhkmx] [-F addflags] [-M fmask] [-n module_name] [-o tmask] [-p prefix] [-s subs] [-v version] [headerfile [extra_libraries]]
  396. version: $H2XS_VERSION
  397.     -A   Omit all autoloading facilities (implies -c).
  398.     -C   Omit creating the Changes file, add HISTORY heading to stub POD.
  399.     -F   Additional flags for C preprocessor (used with -x).
  400.     -M   Mask to select C functions/macros (default is select all).
  401.     -O   Allow overwriting of a pre-existing extension directory.
  402.     -P   Omit the stub POD section.
  403.     -X   Omit the XS portion (implies both -c and -f).
  404.     -a   Generate get/set accessors for struct and union members (used with -x).
  405.     -c   Omit the constant() function and specialised AUTOLOAD from the XS file.
  406.     -d   Turn on debugging messages.
  407.     -f   Force creation of the extension even if the C header does not exist.
  408.     -h   Display this help message
  409.     -k   Omit 'const' attribute on function arguments (used with -x).
  410.     -m   Generate tied variables for access to declared variables.
  411.     -n   Specify a name to use for the extension (recommended).
  412.     -o   Regular expression for \"opaque\" types.
  413.     -p   Specify a prefix which should be removed from the Perl function names.
  414.     -s   Create subroutines for specified macros.
  415.     -v   Specify a version number for this extension.
  416.     -x   Autogenerate XSUBs using C::Scan.
  417.     -b   Specify a perl version to be backwards compatibile with
  418. extra_libraries
  419.          are any libraries that might be needed for loading the
  420.          extension, e.g. -lm would try to link in the math library.
  421. ";
  422. }
  423.  
  424.  
  425. getopts("ACF:M:OPXacdfhkmn:o:p:s:v:xb:") || usage;
  426. use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_a $opt_c $opt_d
  427.         $opt_f $opt_h $opt_k $opt_m $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x 
  428.         $opt_b);
  429.  
  430. usage if $opt_h;
  431.  
  432. if( $opt_b ){
  433.     usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m);
  434.     $opt_b =~ /^\d+\.\d+\.\d+/ ||
  435.     usage "You must provide the backwards compatibility version in X.Y.Z form. " .
  436.         "(i.e. 5.5.0)\n";
  437.     my ($maj,$min,$sub) = split(/\./,$opt_b,3);
  438.     $compat_version = sprintf("%d.%03d%02d",$maj,$min,$sub);
  439. } 
  440.  
  441. if( $opt_v ){
  442.     $TEMPLATE_VERSION = $opt_v;
  443. }
  444.  
  445. # -A implies -c.
  446. $opt_c = 1 if $opt_A;
  447.  
  448. # -X implies -c and -f
  449. $opt_c = $opt_f = 1 if $opt_X;
  450.  
  451. my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s;
  452. my $extralibs;
  453. my @path_h;
  454.  
  455. while (my $arg = shift) {
  456.     if ($arg =~ /^-l/i) {
  457.         $extralibs = "$arg @ARGV";
  458.         last;
  459.     }
  460.     push(@path_h, $arg);
  461. }
  462.  
  463. usage "Must supply header file or module name\n"
  464.         unless (@path_h or $opt_n);
  465.  
  466. my $fmask;
  467. my $tmask;
  468.  
  469. $fmask = qr{$opt_M} if defined $opt_M;
  470. $tmask = qr{$opt_o} if defined $opt_o;
  471. my $tmask_all = $tmask && $opt_o eq '.';
  472.  
  473. if ($opt_x) {
  474.   eval {require C::Scan; 1}
  475.     or die <<EOD;
  476. C::Scan required if you use -x option.
  477. To install C::Scan, execute
  478.    perl -MCPAN -e "install C::Scan"
  479. EOD
  480.   unless ($tmask_all) {
  481.     $C::Scan::VERSION >= 0.70
  482.       or die <<EOD;
  483. C::Scan v. 0.70 or later required unless you use -o . option.
  484. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  485. To install C::Scan, execute
  486.    perl -MCPAN -e "install C::Scan"
  487. EOD
  488.   }
  489.   if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) {
  490.     die <<EOD;
  491. C::Scan v. 0.73 or later required to use -m or -a options.
  492. You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}.
  493. To install C::Scan, execute
  494.    perl -MCPAN -e "install C::Scan"
  495. EOD
  496.   }
  497. }
  498. elsif ($opt_o or $opt_F) {
  499.   warn <<EOD;
  500. Options -o and -F do not make sense without -x.
  501. EOD
  502. }
  503.  
  504. my @path_h_ini = @path_h;
  505. my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names);
  506.  
  507. my $module = $opt_n;
  508.  
  509. if( @path_h ){
  510.     use Config;
  511.     use File::Spec;
  512.     my @paths;
  513.     if ($^O eq 'VMS') {  # Consider overrides of default location
  514.       # XXXX This is not equivalent to what the older version did:
  515.       #        it was looking at $hadsys header-file per header-file...
  516.       my($hadsys) = grep s!^sys/!!i , @path_h;
  517.       @paths = qw( Sys$Library VAXC$Include );
  518.       push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]');
  519.       push @paths, qw( DECC$Library_Include DECC$System_Include );
  520.     }
  521.     else {
  522.       @paths = (File::Spec->curdir(), $Config{usrinc},
  523.         (split ' ', $Config{locincpth}), '/usr/include');
  524.     }
  525.     foreach my $path_h (@path_h) {
  526.         $name ||= $path_h;
  527.     $module ||= do {
  528.       $name =~ s/\.h$//;
  529.       if ( $name !~ /::/ ) {
  530.     $name =~ s#^.*/##;
  531.     $name = "\u$name";
  532.       }
  533.       $name;
  534.     };
  535.  
  536.     if( $path_h =~ s#::#/#g && $opt_n ){
  537.     warn "Nesting of headerfile ignored with -n\n";
  538.     }
  539.     $path_h .= ".h" unless $path_h =~ /\.h$/;
  540.     my $fullpath = $path_h;
  541.     $path_h =~ s/,.*$// if $opt_x;
  542.     $fullpath{$path_h} = $fullpath;
  543.  
  544.     # Minor trickery: we can't chdir() before we processed the headers
  545.     # (so know the name of the extension), but the header may be in the
  546.     # extension directory...
  547.     my $tmp_path_h = $path_h;
  548.     my $rel_path_h = $path_h;
  549.     my @dirs = @paths;
  550.     if (not -f $path_h) {
  551.       my $found;
  552.       for my $dir (@paths) {
  553.     $found++, last
  554.       if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h));
  555.       }
  556.       if ($found) {
  557.     $rel_path_h = $path_h;
  558.       } else {
  559.     (my $epath = $module) =~ s,::,/,g;
  560.     $epath = File::Spec->catdir('ext', $epath) if -d 'ext';
  561.     $rel_path_h = File::Spec->catfile($epath, $tmp_path_h);
  562.     $path_h = $tmp_path_h;    # Used during -x
  563.     push @dirs, $epath;
  564.       }
  565.     }
  566.  
  567.     if (!$opt_c) {
  568.       die "Can't find $tmp_path_h in @dirs\n" 
  569.     if ( ! $opt_f && ! -f "$rel_path_h" );
  570.       # Scan the header file (we should deal with nested header files)
  571.       # Record the names of simple #define constants into const_names
  572.             # Function prototypes are processed below.
  573.       open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n";
  574.     defines:
  575.       while (<CH>) {
  576.     if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) {
  577.         my $def = $1;
  578.         my $rest = $2;
  579.         $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments
  580.         $rest =~ s/^\s+//;
  581.         $rest =~ s/\s+$//;
  582.         # Cannot do: (-1) and ((LHANDLE)3) are OK:
  583.         #print("Skip non-wordy $def => $rest\n"),
  584.         #  next defines if $rest =~ /[^\w\$]/;
  585.         if ($rest =~ /"/) {
  586.           print("Skip stringy $def => $rest\n") if $opt_d;
  587.           next defines;
  588.         }
  589.         print "Matched $_ ($def)\n" if $opt_d;
  590.         $seen_define{$def} = $rest;
  591.         $_ = $def;
  592.         next if /^_.*_h_*$/i; # special case, but for what?
  593.         if (defined $opt_p) {
  594.           if (!/^$opt_p(\d)/) {
  595.         ++$prefix{$_} if s/^$opt_p//;
  596.           }
  597.           else {
  598.         warn "can't remove $opt_p prefix from '$_'!\n";
  599.           }
  600.         }
  601.         $prefixless{$def} = $_;
  602.         if (!$fmask or /$fmask/) {
  603.         print "... Passes mask of -M.\n" if $opt_d and $fmask;
  604.         $const_names{$_}++;
  605.         }
  606.       }
  607.       }
  608.       close(CH);
  609.     }
  610.     }
  611. }
  612.  
  613.  
  614.  
  615. my ($ext, $nested, @modparts, $modfname, $modpname);
  616. (chdir 'ext', $ext = 'ext/') if -d 'ext';
  617.  
  618. if( $module =~ /::/ ){
  619.     $nested = 1;
  620.     @modparts = split(/::/,$module);
  621.     $modfname = $modparts[-1];
  622.     $modpname = join('/',@modparts);
  623. }
  624. else {
  625.     $nested = 0;
  626.     @modparts = ();
  627.     $modfname = $modpname = $module;
  628. }
  629.  
  630.  
  631. if ($opt_O) {
  632.     warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname;
  633. }
  634. else {
  635.     die "Won't overwrite existing $ext$modpname\n" if -e $modpname;
  636. }
  637. if( $nested ){
  638.     my $modpath = "";
  639.     foreach (@modparts){
  640.         mkdir("$modpath$_", 0777);
  641.         $modpath .= "$_/";
  642.     }
  643. }
  644. mkdir($modpname, 0777);
  645. chdir($modpname) || die "Can't chdir $ext$modpname: $!\n";
  646.  
  647. my %types_seen;
  648. my %std_types;
  649. my $fdecls = [];
  650. my $fdecls_parsed = [];
  651. my $typedef_rex;
  652. my %typedefs_pre;
  653. my %known_fnames;
  654. my %structs;
  655.  
  656. my @fnames;
  657. my @fnames_no_prefix;
  658. my %vdecl_hash;
  659. my @vdecls;
  660.  
  661. if( ! $opt_X ){  # use XS, unless it was disabled
  662.   open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n";
  663.   if ($opt_x) {
  664.     require Config;        # Run-time directive
  665.     warn "Scanning typemaps...\n";
  666.     get_typemap();
  667.     my @td;
  668.     my @good_td;
  669.     my $addflags = $opt_F || '';
  670.  
  671.     foreach my $filename (@path_h) {
  672.       my $c;
  673.       my $filter;
  674.  
  675.       if ($fullpath{$filename} =~ /,/) {
  676.     $filename = $`;
  677.     $filter = $';
  678.       }
  679.       warn "Scanning $filename for functions...\n";
  680.       $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter,
  681.     'add_cppflags' => $addflags, 'c_styles' => [qw(C++ C9X)];
  682.       $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]);
  683.  
  684.       push @$fdecls_parsed, @{ $c->get('parsed_fdecls') };
  685.       push(@$fdecls, @{$c->get('fdecls')});
  686.  
  687.       push @td, @{$c->get('typedefs_maybe')};
  688.       if ($opt_a) {
  689.     my $structs = $c->get('typedef_structs');
  690.     @structs{keys %$structs} = values %$structs;
  691.       }
  692.  
  693.       if ($opt_m) {
  694.     %vdecl_hash = %{ $c->get('vdecl_hash') };
  695.     @vdecls = sort keys %vdecl_hash;
  696.     for (local $_ = 0; $_ < @vdecls; ++$_) {
  697.       my $var = $vdecls[$_];
  698.       my($type, $post) = @{ $vdecl_hash{$var} };
  699.       if (defined $post) {
  700.         warn "Can't handle variable '$type $var $post', skipping.\n";
  701.         splice @vdecls, $_, 1;
  702.         redo;
  703.       }
  704.       $type = normalize_type($type);
  705.       $vdecl_hash{$var} = $type;
  706.     }
  707.       }
  708.  
  709.       unless ($tmask_all) {
  710.     warn "Scanning $filename for typedefs...\n";
  711.     my $td = $c->get('typedef_hash');
  712.     # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d;
  713.     my @f_good_td = grep $td->{$_}[1] eq '', keys %$td;
  714.     push @good_td, @f_good_td;
  715.     @typedefs_pre{@f_good_td}  = map $_->[0], @$td{@f_good_td};
  716.       }
  717.     }
  718.     { local $" = '|';
  719.       $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td;
  720.     }
  721.     %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT
  722.     if ($fmask) {
  723.       my @good;
  724.       for my $i (0..$#$fdecls_parsed) {
  725.     next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME
  726.     push @good, $i;
  727.     print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n"
  728.       if $opt_d;
  729.       }
  730.       $fdecls = [@$fdecls[@good]];
  731.       $fdecls_parsed = [@$fdecls_parsed[@good]];
  732.     }
  733.     @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME
  734.     # Sort declarations:
  735.     {
  736.       my %h = map( ($_->[1], $_), @$fdecls_parsed);
  737.       $fdecls_parsed = [ @h{@fnames} ];
  738.     }
  739.     @fnames_no_prefix = @fnames;
  740.     @fnames_no_prefix
  741.       = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix;
  742.     # Remove macros which expand to typedefs
  743.     print "Typedefs are @td.\n" if $opt_d;
  744.     my %td = map {($_, $_)} @td;
  745.     # Add some other possible but meaningless values for macros
  746.     for my $k (qw(char double float int long short unsigned signed void)) {
  747.       $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned ');
  748.     }
  749.     # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@;
  750.     my $n = 0;
  751.     my %bad_macs;
  752.     while (keys %td > $n) {
  753.       $n = keys %td;
  754.       my ($k, $v);
  755.       while (($k, $v) = each %seen_define) {
  756.     # print("found '$k'=>'$v'\n"), 
  757.     $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v};
  758.       }
  759.     }
  760.     # Now %bad_macs contains names of bad macros
  761.     for my $k (keys %bad_macs) {
  762.       delete $const_names{$prefixless{$k}};
  763.       print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d;
  764.     }
  765.   }
  766. }
  767. my @const_names = sort keys %const_names;
  768.  
  769. open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n";
  770.  
  771. $" = "\n\t";
  772. warn "Writing $ext$modpname/$modfname.pm\n";
  773.  
  774. if ( $compat_version < 5.006 ) {
  775. print PM <<"END";
  776. package $module;
  777.  
  778. use $compat_version;
  779. use strict;
  780. END
  781. } 
  782. else {
  783. print PM <<"END";
  784. package $module;
  785.  
  786. use 5.006;
  787. use strict;
  788. use warnings;
  789. END
  790. }
  791.  
  792. unless( $opt_X || $opt_c || $opt_A ){
  793.     # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and
  794.     # will want Carp.
  795.     print PM <<'END';
  796. use Carp;
  797. END
  798. }
  799.  
  800. print PM <<'END';
  801.  
  802. require Exporter;
  803. END
  804.  
  805. print PM <<"END" if ! $opt_X;  # use DynaLoader, unless XS was disabled
  806. require DynaLoader;
  807. END
  808.  
  809.  
  810. # Are we using AutoLoader or not?
  811. unless ($opt_A) { # no autoloader whatsoever.
  812.     unless ($opt_c) { # we're doing the AUTOLOAD
  813.         print PM "use AutoLoader;\n";
  814.     }
  815.     else {
  816.         print PM "use AutoLoader qw(AUTOLOAD);\n"
  817.     }
  818. }
  819.  
  820. if ( $compat_version < 5.006 ) {
  821.     if ( $opt_X || $opt_c || $opt_A ) {
  822.     print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);';
  823.     } else {
  824.     print PM 'use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $AUTOLOAD);';
  825.     }
  826. }
  827.  
  828. # Determine @ISA.
  829. my $myISA = 'our @ISA = qw(Exporter';    # We seem to always want this.
  830. $myISA .= ' DynaLoader'     unless $opt_X;  # no XS
  831. $myISA .= ');';
  832. $myISA =~ s/^our // if $compat_version < 5.006;
  833.  
  834. print PM "\n$myISA\n\n";
  835.  
  836. my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls);
  837.  
  838. my $tmp=<<"END";
  839. # Items to export into callers namespace by default. Note: do not export
  840. # names by default without a very good reason. Use EXPORT_OK instead.
  841. # Do not simply export all your public functions/methods/constants.
  842.  
  843. # This allows declaration    use $module ':all';
  844. # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK
  845. # will save memory.
  846. our %EXPORT_TAGS = ( 'all' => [ qw(
  847.     @exported_names
  848. ) ] );
  849.  
  850. our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } );
  851.  
  852. our \@EXPORT = qw(
  853.     @const_names
  854. );
  855. our \$VERSION = '$TEMPLATE_VERSION';
  856.  
  857. END
  858.  
  859. $tmp =~ s/^our //mg if $compat_version < 5.006;
  860. print PM $tmp;
  861.  
  862. if (@vdecls) {
  863.     printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n";
  864. }
  865.  
  866.  
  867. $tmp = ( $compat_version < 5.006 ?  "" : "our \$AUTOLOAD;" );
  868. print PM <<"END" unless $opt_c or $opt_X;
  869. sub AUTOLOAD {
  870.     # This AUTOLOAD is used to 'autoload' constants from the constant()
  871.     # XS function.  If a constant is not found then control is passed
  872.     # to the AUTOLOAD in AutoLoader.
  873.  
  874.     my \$constname;
  875.     $tmp
  876.     (\$constname = \$AUTOLOAD) =~ s/.*:://;
  877.     croak "&$module::constant not defined" if \$constname eq 'constant';
  878.     local \$! = 0;
  879.     my \$val = constant(\$constname, \@_ ? \$_[0] : 0);
  880.     if (\$! != 0) {
  881.     if (\$! =~ /Invalid/ || \$!{EINVAL}) {
  882.         \$AutoLoader::AUTOLOAD = \$AUTOLOAD;
  883.         goto &AutoLoader::AUTOLOAD;
  884.     }
  885.     else {
  886.         croak "Your vendor has not defined $module macro \$constname";
  887.     }
  888.     }
  889.     {
  890.     no strict 'refs';
  891.     # Fixed between 5.005_53 and 5.005_61
  892.     if (\$] >= 5.00561) {
  893.         *\$AUTOLOAD = sub () { \$val };
  894.     }
  895.     else {
  896.         *\$AUTOLOAD = sub { \$val };
  897.     }
  898.     }
  899.     goto &\$AUTOLOAD;
  900. }
  901.  
  902. END
  903.  
  904. if( ! $opt_X ){ # print bootstrap, unless XS is disabled
  905.     print PM <<"END";
  906. bootstrap $module \$VERSION;
  907. END
  908. }
  909.  
  910. # tying the variables can happen only after bootstrap
  911. if (@vdecls) {
  912.     printf PM <<END;
  913. {
  914. @{[ join "\n", map "    _tievar_$_(\$$_);", @vdecls ]}
  915. }
  916.  
  917. END
  918. }
  919.  
  920. my $after;
  921. if( $opt_P ){ # if POD is disabled
  922.     $after = '__END__';
  923. }
  924. else {
  925.     $after = '=cut';
  926. }
  927.  
  928. print PM <<"END";
  929.  
  930. # Preloaded methods go here.
  931. END
  932.  
  933. print PM <<"END" unless $opt_A;
  934.  
  935. # Autoload methods go after $after, and are processed by the autosplit program.
  936. END
  937.  
  938. print PM <<"END";
  939.  
  940. 1;
  941. __END__
  942. END
  943.  
  944. my $author = "A. U. Thor";
  945. my $email = 'a.u.thor@a.galaxy.far.far.away';
  946.  
  947. my $revhist = '';
  948. $revhist = <<EOT if $opt_C;
  949. #
  950. #=head1 HISTORY
  951. #
  952. #=over 8
  953. #
  954. #=item $TEMPLATE_VERSION
  955. #
  956. #Original version; created by h2xs $H2XS_VERSION with options
  957. #
  958. #  @ARGS
  959. #
  960. #=back
  961. #
  962. EOT
  963.  
  964. my $exp_doc = <<EOD;
  965. #
  966. #=head2 EXPORT
  967. #
  968. #None by default.
  969. #
  970. EOD
  971.  
  972. if (@const_names and not $opt_P) {
  973.   $exp_doc .= <<EOD;
  974. #=head2 Exportable constants
  975. #
  976. #  @{[join "\n  ", @const_names]}
  977. #
  978. EOD
  979. }
  980.  
  981. if (defined $fdecls and @$fdecls and not $opt_P) {
  982.   $exp_doc .= <<EOD;
  983. #=head2 Exportable functions
  984. #
  985. EOD
  986.  
  987. #  $exp_doc .= <<EOD if $opt_p;
  988. #When accessing these functions from Perl, prefix C<$opt_p> should be removed.
  989. #
  990. #EOD
  991.   $exp_doc .= <<EOD;
  992. #  @{[join "\n  ", @known_fnames{@fnames}]}
  993. #
  994. EOD
  995. }
  996.  
  997. my $meth_doc = '';
  998.  
  999. if ($opt_x && $opt_a) {
  1000.   my($name, $struct);
  1001.   $meth_doc .= accessor_docs($name, $struct)
  1002.     while ($name, $struct) = each %structs;
  1003. }
  1004.  
  1005. my $pod = <<"END" unless $opt_P;
  1006. ## Below is stub documentation for your module. You better edit it!
  1007. #
  1008. #=head1 NAME
  1009. #
  1010. #$module - Perl extension for blah blah blah
  1011. #
  1012. #=head1 SYNOPSIS
  1013. #
  1014. #  use $module;
  1015. #  blah blah blah
  1016. #
  1017. #=head1 DESCRIPTION
  1018. #
  1019. #Stub documentation for $module, created by h2xs. It looks like the
  1020. #author of the extension was negligent enough to leave the stub
  1021. #unedited.
  1022. #
  1023. #Blah blah blah.
  1024. $exp_doc$meth_doc$revhist
  1025. #=head1 AUTHOR
  1026. #
  1027. #$author, E<lt>${email}E<gt>
  1028. #
  1029. #=head1 SEE ALSO
  1030. #
  1031. #L<perl>.
  1032. #
  1033. #=cut
  1034. END
  1035.  
  1036. $pod =~ s/^\#//gm unless $opt_P;
  1037. print PM $pod unless $opt_P;
  1038.  
  1039. close PM;
  1040.  
  1041.  
  1042. if( ! $opt_X ){ # print XS, unless it is disabled
  1043. warn "Writing $ext$modpname/$modfname.xs\n";
  1044.  
  1045. print XS <<"END";
  1046. #include "EXTERN.h"
  1047. #include "perl.h"
  1048. #include "XSUB.h"
  1049.  
  1050. END
  1051. if( @path_h ){
  1052.     foreach my $path_h (@path_h_ini) {
  1053.     my($h) = $path_h;
  1054.     $h =~ s#^/usr/include/##;
  1055.     if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; }
  1056.         print XS qq{#include <$h>\n};
  1057.     }
  1058.     print XS "\n";
  1059. }
  1060.  
  1061. my %pointer_typedefs;
  1062. my %struct_typedefs;
  1063.  
  1064. sub td_is_pointer {
  1065.   my $type = shift;
  1066.   my $out = $pointer_typedefs{$type};
  1067.   return $out if defined $out;
  1068.   my $otype = $type;
  1069.   $out = ($type =~ /\*$/);
  1070.   # This converts only the guys which do not have trailing part in the typedef
  1071.   if (not $out
  1072.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1073.     $type = normalize_type($type);
  1074.     print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n"
  1075.       if $opt_d;
  1076.     $out = td_is_pointer($type);
  1077.   }
  1078.   return ($pointer_typedefs{$otype} = $out);
  1079. }
  1080.  
  1081. sub td_is_struct {
  1082.   my $type = shift;
  1083.   my $out = $struct_typedefs{$type};
  1084.   return $out if defined $out;
  1085.   my $otype = $type;
  1086.   $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type);
  1087.   # This converts only the guys which do not have trailing part in the typedef
  1088.   if (not $out
  1089.       and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1090.     $type = normalize_type($type);
  1091.     print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n"
  1092.       if $opt_d;
  1093.     $out = td_is_struct($type);
  1094.   }
  1095.   return ($struct_typedefs{$otype} = $out);
  1096. }
  1097.  
  1098. # Some macros will bomb if you try to return them from a double-returning func.
  1099. # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen).
  1100. # Fortunately, we can detect both these cases...
  1101. sub protect_convert_to_double {
  1102.   my $in = shift;
  1103.   my $val;
  1104.   return '' unless defined ($val = $seen_define{$in});
  1105.   return '(IV)' if $known_fnames{$val};
  1106.   # OUT_t of ((OUT_t)-1):
  1107.   return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/;
  1108.   td_is_pointer($2) ? '(IV)' : '';
  1109. }
  1110.  
  1111. # For each of the generated functions, length($pref) leading
  1112. # letters are already checked.  Moreover, it is recommended that
  1113. # the generated functions uses switch on letter at offset at least
  1114. # $off + length($pref).
  1115. #
  1116. # The given list has length($pref) chars removed at front, it is
  1117. # guarantied that $off leading chars in the rest are the same for all
  1118. # elts of the list.
  1119. #
  1120. # Returns: how at which offset it was decided to make a switch, or -1 if none.
  1121.  
  1122. sub write_const;
  1123.  
  1124. sub write_const {
  1125.   my ($fh, $pref, $off, $list) = (shift,shift,shift,shift);
  1126.   my %leading;
  1127.   my $offarg = length $pref;
  1128.  
  1129.   if (@$list == 0) {        # Can happen on the initial iteration only
  1130.     print $fh <<"END";
  1131. static double
  1132. constant(char *name, int len, int arg)
  1133. {
  1134.     errno = EINVAL;
  1135.     return 0;
  1136. }
  1137. END
  1138.     return -1;
  1139.   }
  1140.  
  1141.   if (@$list == 1) {        # Can happen on the initial iteration only
  1142.     my $protect = protect_convert_to_double("$pref$list->[0]");
  1143.  
  1144.     print $fh <<"END";
  1145. static double
  1146. constant(char *name, int len, int arg)
  1147. {
  1148.     errno = 0;
  1149.     if (strEQ(name + $offarg, "$list->[0]")) {    /* $pref removed */
  1150. #ifdef $pref$list->[0]
  1151.     return $protect$pref$list->[0];
  1152. #else
  1153.     errno = ENOENT;
  1154.     return 0;
  1155. #endif
  1156.     }
  1157.     errno = EINVAL;
  1158.     return 0;
  1159. }
  1160. END
  1161.     return -1;
  1162.   }
  1163.  
  1164.   for my $n (@$list) {
  1165.     my $c = substr $n, $off, 1;
  1166.     $leading{$c} = [] unless exists $leading{$c};
  1167.     push @{$leading{$c}}, substr $n, $off + 1;
  1168.   }
  1169.  
  1170.   if (keys(%leading) == 1) {
  1171.     return 1 + write_const $fh, $pref, $off + 1, $list;
  1172.   }
  1173.  
  1174.   my $leader = substr $list->[0], 0, $off;
  1175.   foreach my $letter (keys %leading) {
  1176.     write_const $fh, "$pref$leader$letter", 0, $leading{$letter}
  1177.       if @{$leading{$letter}} > 1;
  1178.   }
  1179.  
  1180.   my $npref = "_$pref";
  1181.   $npref = '' if $pref eq '';
  1182.  
  1183.   print $fh <<"END";
  1184. static double
  1185. constant$npref(char *name, int len, int arg)
  1186. {
  1187. END
  1188.  
  1189.   print $fh <<"END" if $npref eq '';
  1190.     errno = 0;
  1191. END
  1192.  
  1193.   if ($off) {
  1194.       my $null = 0;
  1195.  
  1196.       foreach my $letter (keys %leading) {
  1197.       if ($letter eq '') {
  1198.           $null = 1;
  1199.           last;
  1200.       }
  1201.       }
  1202.  
  1203.       my $cmp = $null ? '>' : '>=';
  1204.  
  1205.       print $fh <<"END"
  1206.     if ($offarg + $off $cmp len ) {
  1207.     errno = EINVAL;
  1208.     return 0;
  1209.     }
  1210. END
  1211.   }
  1212.  
  1213.   print $fh <<"END";
  1214.     switch (name[$offarg + $off]) {
  1215. END
  1216.  
  1217.   foreach my $letter (sort keys %leading) {
  1218.     my $let = $letter;
  1219.     $let = '\0' if $letter eq '';
  1220.  
  1221.     print $fh <<EOP;
  1222.     case '$let':
  1223. EOP
  1224.     if (@{$leading{$letter}} > 1) {
  1225.       # It makes sense to call a function
  1226.       if ($off) {
  1227.     print $fh <<EOP;
  1228.     if (!strnEQ(name + $offarg,"$leader", $off))
  1229.         break;
  1230. EOP
  1231.       }
  1232.       print $fh <<EOP;
  1233.     return constant_$pref$leader$letter(name, len, arg);
  1234. EOP
  1235.     }
  1236.     else {
  1237.       # Do it ourselves
  1238.       my $protect
  1239.     = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]");
  1240.  
  1241.       print $fh <<EOP;
  1242.     if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) {    /* $pref removed */
  1243. #ifdef $pref$leader$letter$leading{$letter}[0]
  1244.         return $protect$pref$leader$letter$leading{$letter}[0];
  1245. #else
  1246.         goto not_there;
  1247. #endif
  1248.     }
  1249. EOP
  1250.     }
  1251.   }
  1252.   print $fh <<"END";
  1253.     }
  1254.     errno = EINVAL;
  1255.     return 0;
  1256.  
  1257. not_there:
  1258.     errno = ENOENT;
  1259.     return 0;
  1260. }
  1261.  
  1262. END
  1263.  
  1264. }
  1265.  
  1266. if( ! $opt_c ) {
  1267.   print XS <<"END";
  1268. static int
  1269. not_here(char *s)
  1270. {
  1271.     croak("$module::%s not implemented on this architecture", s);
  1272.     return -1;
  1273. }
  1274.  
  1275. END
  1276.  
  1277.   write_const(\*XS, '', 0, \@const_names);
  1278. }
  1279.  
  1280. print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls;
  1281.  
  1282. my $prefix;
  1283. $prefix = "PREFIX = $opt_p" if defined $opt_p;
  1284.  
  1285. # Now switch from C to XS by issuing the first MODULE declaration:
  1286. print XS <<"END";
  1287.  
  1288. MODULE = $module        PACKAGE = $module        $prefix
  1289.  
  1290. END
  1291.  
  1292. foreach (sort keys %const_xsub) {
  1293.     print XS <<"END";
  1294. char *
  1295. $_()
  1296.  
  1297.     CODE:
  1298. #ifdef $_
  1299.     RETVAL = $_;
  1300. #else
  1301.     croak("Your vendor has not defined the $module macro $_");
  1302. #endif
  1303.  
  1304.     OUTPUT:
  1305.     RETVAL
  1306.  
  1307. END
  1308. }
  1309.  
  1310. # If a constant() function was written then output a corresponding
  1311. # XS declaration:
  1312. print XS <<"END" unless $opt_c;
  1313.  
  1314. double
  1315. constant(sv,arg)
  1316.     PREINIT:
  1317.     STRLEN        len;
  1318.     INPUT:
  1319.     SV *        sv
  1320.     char *        s = SvPV(sv, len);
  1321.     int        arg
  1322.     CODE:
  1323.     RETVAL = constant(s,len,arg);
  1324.     OUTPUT:
  1325.     RETVAL
  1326.  
  1327. END
  1328.  
  1329. my %seen_decl;
  1330. my %typemap;
  1331.  
  1332. sub print_decl {
  1333.   my $fh = shift;
  1334.   my $decl = shift;
  1335.   my ($type, $name, $args) = @$decl;
  1336.   return if $seen_decl{$name}++; # Need to do the same for docs as well?
  1337.  
  1338.   my @argnames = map {$_->[1]} @$args;
  1339.   my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args;
  1340.   if ($opt_k) {
  1341.     s/^\s*const\b\s*// for @argtypes;
  1342.   }
  1343.   my @argarrays = map { $_->[4] || '' } @$args;
  1344.   my $numargs = @$args;
  1345.   if ($numargs and $argtypes[-1] eq '...') {
  1346.     $numargs--;
  1347.     $argnames[-1] = '...';
  1348.   }
  1349.   local $" = ', ';
  1350.   $type = normalize_type($type, 1);
  1351.  
  1352.   print $fh <<"EOP";
  1353.  
  1354. $type
  1355. $name(@argnames)
  1356. EOP
  1357.  
  1358.   for my $arg (0 .. $numargs - 1) {
  1359.     print $fh <<"EOP";
  1360.     $argtypes[$arg]    $argnames[$arg]$argarrays[$arg]
  1361. EOP
  1362.   }
  1363. }
  1364.  
  1365. sub print_tievar_subs {
  1366.   my($fh, $name, $type) = @_;
  1367.   print $fh <<END;
  1368. I32
  1369. _get_$name(IV index, SV *sv) {
  1370.     dSP;
  1371.     PUSHMARK(SP);
  1372.     XPUSHs(sv);
  1373.     PUTBACK;
  1374.     (void)call_pv("$module\::_get_$name", G_DISCARD);
  1375.     return (I32)0;
  1376. }
  1377.  
  1378. I32
  1379. _set_$name(IV index, SV *sv) {
  1380.     dSP;
  1381.     PUSHMARK(SP);
  1382.     XPUSHs(sv);
  1383.     PUTBACK;
  1384.     (void)call_pv("$module\::_set_$name", G_DISCARD);
  1385.     return (I32)0;
  1386. }
  1387.  
  1388. END
  1389. }
  1390.  
  1391. sub print_tievar_xsubs {
  1392.   my($fh, $name, $type) = @_;
  1393.   print $fh <<END;
  1394. void
  1395. _tievar_$name(sv)
  1396.     SV* sv
  1397.     PREINIT:
  1398.     struct ufuncs uf;
  1399.     CODE:
  1400.     uf.uf_val = &_get_$name;
  1401.     uf.uf_set = &_set_$name;
  1402.     uf.uf_index = (IV)&_get_$name;
  1403.     sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
  1404.  
  1405. void
  1406. _get_$name(THIS)
  1407.     $type THIS = NO_INIT
  1408.     CODE:
  1409.     THIS = $name;
  1410.     OUTPUT:
  1411.     SETMAGIC: DISABLE
  1412.     THIS
  1413.  
  1414. void
  1415. _set_$name(THIS)
  1416.     $type THIS
  1417.     CODE:
  1418.     $name = THIS;
  1419.  
  1420. END
  1421. }
  1422.  
  1423. sub print_accessors {
  1424.   my($fh, $name, $struct) = @_;
  1425.   return unless defined $struct && $name !~ /\s|_ANON/;
  1426.   $name = normalize_type($name);
  1427.   my $ptrname = normalize_type("$name *");
  1428.   print $fh <<"EOF";
  1429.  
  1430. MODULE = $module        PACKAGE = ${name}        $prefix
  1431.  
  1432. $name *
  1433. _to_ptr(THIS)
  1434.     $name THIS = NO_INIT
  1435.     PROTOTYPE: \$
  1436.     CODE:
  1437.     if (sv_derived_from(ST(0), "$name")) {
  1438.         STRLEN len;
  1439.         char *s = SvPV((SV*)SvRV(ST(0)), len);
  1440.         if (len != sizeof(THIS))
  1441.         croak("Size \%d of packed data != expected \%d",
  1442.             len, sizeof(THIS));
  1443.         RETVAL = ($name *)s;
  1444.     }   
  1445.     else
  1446.         croak("THIS is not of type $name");
  1447.     OUTPUT:
  1448.     RETVAL
  1449.  
  1450. $name
  1451. new(CLASS)
  1452.     char *CLASS = NO_INIT
  1453.     PROTOTYPE: \$
  1454.     CODE:
  1455.     Zero((void*)&RETVAL, sizeof(RETVAL), char);
  1456.     OUTPUT:
  1457.     RETVAL
  1458.  
  1459. MODULE = $module        PACKAGE = ${name}Ptr        $prefix
  1460.  
  1461. EOF
  1462.   my @items = @$struct;
  1463.   while (@items) {
  1464.     my $item = shift @items;
  1465.     if ($item->[0] =~ /_ANON/) {
  1466.       if (defined $item->[2]) {
  1467.     push @items, map [
  1468.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1469.     ], @{ $structs{$item->[0]} };
  1470.       } else {
  1471.     push @items, @{ $structs{$item->[0]} };
  1472.       }
  1473.     } else {
  1474.       my $type = normalize_type($item->[0]);
  1475.       my $ttype = $structs{$type} ? normalize_type("$type *") : $type;
  1476.       print $fh <<"EOF";
  1477. $ttype
  1478. $item->[2](THIS, __value = NO_INIT)
  1479.     $ptrname THIS
  1480.     $type __value
  1481.     PROTOTYPE: \$;\$
  1482.     CODE:
  1483.     if (items > 1)
  1484.         THIS->$item->[-1] = __value;
  1485.     RETVAL = @{[
  1486.         $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])"
  1487.     ]};
  1488.     OUTPUT:
  1489.     RETVAL
  1490.  
  1491. EOF
  1492.     }
  1493.   }
  1494. }
  1495.  
  1496. sub accessor_docs {
  1497.   my($name, $struct) = @_;
  1498.   return unless defined $struct && $name !~ /\s|_ANON/;
  1499.   $name = normalize_type($name);
  1500.   my $ptrname = $name . 'Ptr';
  1501.   my @items = @$struct;
  1502.   my @list;
  1503.   while (@items) {
  1504.     my $item = shift @items;
  1505.     if ($item->[0] =~ /_ANON/) {
  1506.       if (defined $item->[2]) {
  1507.     push @items, map [
  1508.       @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]",
  1509.     ], @{ $structs{$item->[0]} };
  1510.       } else {
  1511.     push @items, @{ $structs{$item->[0]} };
  1512.       }
  1513.     } else {
  1514.       push @list, $item->[2];
  1515.     }
  1516.   }
  1517.   my $methods = (join '(...)>, C<', @list) . '(...)';
  1518.  
  1519.   my $pod = <<"EOF";
  1520. #
  1521. #=head2 Object and class methods for C<$name>/C<$ptrname>
  1522. #
  1523. #The principal Perl representation of a C object of type C<$name> is an
  1524. #object of class C<$ptrname> which is a reference to an integer
  1525. #representation of a C pointer.  To create such an object, one may use
  1526. #a combination
  1527. #
  1528. #  my \$buffer = $name->new();
  1529. #  my \$obj = \$buffer->_to_ptr();
  1530. #
  1531. #This exersizes the following two methods, and an additional class
  1532. #C<$name>, the internal representation of which is a reference to a
  1533. #packed string with the C structure.  Keep in mind that \$buffer should
  1534. #better survive longer than \$obj.
  1535. #
  1536. #=over
  1537. #
  1538. #=item C<\$object_of_type_$name-E<gt>_to_ptr()>
  1539. #
  1540. #Converts an object of type C<$name> to an object of type C<$ptrname>.
  1541. #
  1542. #=item C<$name-E<gt>new()>
  1543. #
  1544. #Creates an empty object of type C<$name>.  The corresponding packed
  1545. #string is zeroed out.
  1546. #
  1547. #=item C<$methods>
  1548. #
  1549. #return the current value of the corresponding element if called
  1550. #without additional arguments.  Set the element to the supplied value
  1551. #(and return the new value) if called with an additional argument.
  1552. #
  1553. #Applicable to objects of type C<$ptrname>.
  1554. #
  1555. #=back
  1556. #
  1557. EOF
  1558.   $pod =~ s/^\#//gm;
  1559.   return $pod;
  1560. }
  1561.  
  1562. # Should be called before any actual call to normalize_type().
  1563. sub get_typemap {
  1564.   # We do not want to read ./typemap by obvios reasons.
  1565.   my @tm =  qw(../../../typemap ../../typemap ../typemap);
  1566.   my $stdtypemap =  "$Config::Config{privlib}/ExtUtils/typemap";
  1567.   unshift @tm, $stdtypemap;
  1568.   my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
  1569.  
  1570.   # Start with useful default values
  1571.   $typemap{float} = 'T_DOUBLE';
  1572.  
  1573.   foreach my $typemap (@tm) {
  1574.     next unless -e $typemap ;
  1575.     # skip directories, binary files etc.
  1576.     warn " Scanning $typemap\n";
  1577.     warn("Warning: ignoring non-text typemap file '$typemap'\n"), next 
  1578.       unless -T $typemap ;
  1579.     open(TYPEMAP, $typemap) 
  1580.       or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
  1581.     my $mode = 'Typemap';
  1582.     while (<TYPEMAP>) {
  1583.       next if /^\s*\#/;
  1584.       if (/^INPUT\s*$/)   { $mode = 'Input'; next; }
  1585.       elsif (/^OUTPUT\s*$/)  { $mode = 'Output'; next; }
  1586.       elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; }
  1587.       elsif ($mode eq 'Typemap') {
  1588.     next if /^\s*($|\#)/ ;
  1589.     my ($type, $image);
  1590.     if ( ($type, $image) =
  1591.          /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o
  1592.          # This may reference undefined functions:
  1593.          and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) {
  1594.       $typemap{normalize_type($type)} = $image;
  1595.     }
  1596.       }
  1597.     }
  1598.     close(TYPEMAP) or die "Cannot close $typemap: $!";
  1599.   }
  1600.   %std_types = %types_seen;
  1601.   %types_seen = ();
  1602. }
  1603.  
  1604.  
  1605. sub normalize_type {        # Second arg: do not strip const's before \*
  1606.   my $type = shift;
  1607.   my $do_keep_deep_const = shift;
  1608.   # If $do_keep_deep_const this is heuristical only
  1609.   my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : '');
  1610.   my $ignore_mods 
  1611.     = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*";
  1612.   if ($do_keep_deep_const) {    # Keep different compiled /RExen/o separately!
  1613.     $type =~ s/$ignore_mods//go;
  1614.   }
  1615.   else {
  1616.     $type =~ s/$ignore_mods//go;
  1617.   }
  1618.   $type =~ s/([^\s\w])/ \1 /g;
  1619.   $type =~ s/\s+$//;
  1620.   $type =~ s/^\s+//;
  1621.   $type =~ s/\s+/ /g;
  1622.   $type =~ s/\* (?=\*)/*/g;
  1623.   $type =~ s/\. \. \./.../g;
  1624.   $type =~ s/ ,/,/g;
  1625.   $types_seen{$type}++ 
  1626.     unless $type eq '...' or $type eq 'void' or $std_types{$type};
  1627.   $type;
  1628. }
  1629.  
  1630. my $need_opaque;
  1631.  
  1632. sub assign_typemap_entry {
  1633.   my $type = shift;
  1634.   my $otype = $type;
  1635.   my $entry;
  1636.   if ($tmask and $type =~ /$tmask/) {
  1637.     print "Type $type matches -o mask\n" if $opt_d;
  1638.     $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1639.   }
  1640.   elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) {
  1641.     $type = normalize_type $type;
  1642.     print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d;
  1643.     $entry = assign_typemap_entry($type);
  1644.   }
  1645.   $entry ||= $typemap{$otype}
  1646.     || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ");
  1647.   $typemap{$otype} = $entry;
  1648.   $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT";
  1649.   return $entry;
  1650. }
  1651.  
  1652. for (@vdecls) {
  1653.   print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_});
  1654. }
  1655.  
  1656. if ($opt_x) {
  1657.   for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) }
  1658.   if ($opt_a) {
  1659.     while (my($name, $struct) = each %structs) {
  1660.       print_accessors(\*XS, $name, $struct);
  1661.     }
  1662.   }
  1663. }
  1664.  
  1665. close XS;
  1666.  
  1667. if (%types_seen) {
  1668.   my $type;
  1669.   warn "Writing $ext$modpname/typemap\n";
  1670.   open TM, ">typemap" or die "Cannot open typemap file for write: $!";
  1671.  
  1672.   for $type (sort keys %types_seen) {
  1673.     my $entry = assign_typemap_entry $type;
  1674.     print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n"
  1675.   }
  1676.  
  1677.   print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry
  1678. #############################################################################
  1679. INPUT
  1680. T_OPAQUE_STRUCT
  1681.     if (sv_derived_from($arg, \"${ntype}\")) {
  1682.         STRLEN len;
  1683.         char  *s = SvPV((SV*)SvRV($arg), len);
  1684.  
  1685.         if (len != sizeof($var))
  1686.         croak(\"Size %d of packed data != expected %d\",
  1687.             len, sizeof($var));
  1688.         $var = *($type *)s;
  1689.     }
  1690.     else
  1691.         croak(\"$var is not of type ${ntype}\")
  1692. #############################################################################
  1693. OUTPUT
  1694. T_OPAQUE_STRUCT
  1695.     sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var));
  1696. EOP
  1697.  
  1698.   close TM or die "Cannot close typemap file for write: $!";
  1699. }
  1700.  
  1701. } # if( ! $opt_X )
  1702.  
  1703. warn "Writing $ext$modpname/Makefile.PL\n";
  1704. open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n";
  1705.  
  1706. print PL <<END;
  1707. use ExtUtils::MakeMaker;
  1708. # See lib/ExtUtils/MakeMaker.pm for details of how to influence
  1709. # the contents of the Makefile that is written.
  1710. WriteMakefile(
  1711.     'NAME'        => '$module',
  1712.     'VERSION_FROM'    => '$modfname.pm', # finds \$VERSION
  1713.     'PREREQ_PM'        => {}, # e.g., Module::Name => 1.1
  1714.     (\$] >= 5.005 ?    ## Add these new keywords supported since 5.005
  1715.       (ABSTRACT_FROM => '$modfname.pm', # retrieve abstract from module
  1716.        AUTHOR     => '$author <$email>') : ()),
  1717. END
  1718. if (!$opt_X) { # print C stuff, unless XS is disabled
  1719.   $opt_F = '' unless defined $opt_F;
  1720.   my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : '');
  1721.   my $Ihelp = ($I ? '-I. ' : '');
  1722.   my $Icomment = ($I ? '' : <<EOC);
  1723.     # Insert -I. if you add *.h files later:
  1724. EOC
  1725.  
  1726.   print PL <<END;
  1727.     'LIBS'        => ['$extralibs'], # e.g., '-lm'
  1728.     'DEFINE'        => '$opt_F', # e.g., '-DHAVE_SOMETHING'
  1729. $Icomment    'INC'        => '$I', # e.g., '$Ihelp-I/usr/include/other'
  1730. END
  1731.  
  1732.   my $C = grep $_ ne "$modfname.c", (glob '*.c'), (glob '*.cc'), (glob '*.C');
  1733.   my $Cpre = ($C ? '' : '# ');
  1734.   my $Ccomment = ($C ? '' : <<EOC);
  1735.     # Un-comment this if you add C files to link with later:
  1736. EOC
  1737.  
  1738.   print PL <<END;
  1739. $Ccomment    $Cpre\'OBJECT'        => '\$(O_FILES)', # link all the C files too
  1740. END
  1741. }
  1742. print PL ");\n";
  1743. close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n";
  1744.  
  1745. # Create a simple README since this is a CPAN requirement
  1746. # and it doesnt hurt to have one
  1747. warn "Writing $ext$modpname/README\n";
  1748. open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n";
  1749. my $thisyear = (gmtime)[5] + 1900;
  1750. my $rmhead = "$modpname version $TEMPLATE_VERSION";
  1751. my $rmheadeq = "=" x length($rmhead);
  1752. print RM <<_RMEND_;
  1753. $rmhead
  1754. $rmheadeq
  1755.  
  1756. The README is used to introduce the module and provide instructions on
  1757. how to install the module, any machine dependencies it may have (for
  1758. example C compilers and installed libraries) and any other information
  1759. that should be provided before the module is installed.
  1760.  
  1761. A README file is required for CPAN modules since CPAN extracts the
  1762. README file from a module distribution so that people browsing the
  1763. archive can use it get an idea of the modules uses. It is usually a
  1764. good idea to provide version information here so that people can
  1765. decide whether fixes for the module are worth downloading.
  1766.  
  1767. INSTALLATION
  1768.  
  1769. To install this module type the following:
  1770.  
  1771.    perl Makefile.PL
  1772.    make
  1773.    make test
  1774.    make install
  1775.  
  1776. DEPENDENCIES
  1777.  
  1778. This module requires these other modules and libraries:
  1779.  
  1780.   blah blah blah
  1781.  
  1782. COPYRIGHT AND LICENCE
  1783.  
  1784. Put the correct copyright and licence information here.
  1785.  
  1786. Copyright (C) $thisyear $author
  1787.  
  1788. This library is free software; you can redistribute it and/or modify
  1789. it under the same terms as Perl itself. 
  1790.  
  1791. _RMEND_
  1792. close(RM) || die "Can't close $ext$modpname/README: $!\n";
  1793.  
  1794. warn "Writing $ext$modpname/test.pl\n";
  1795. open(EX, ">test.pl") || die "Can't create $ext$modpname/test.pl: $!\n";
  1796. print EX <<'_END_';
  1797. # Before `make install' is performed this script should be runnable with
  1798. # `make test'. After `make install' it should work as `perl test.pl'
  1799.  
  1800. #########################
  1801.  
  1802. # change 'tests => 1' to 'tests => last_test_to_print';
  1803.  
  1804. use Test;
  1805. BEGIN { plan tests => 1 };
  1806. _END_
  1807. print EX <<_END_;
  1808. use $module;
  1809. _END_
  1810. print EX <<'_END_';
  1811. ok(1); # If we made it this far, we're ok.
  1812.  
  1813. #########################
  1814.  
  1815. # Insert your test code below, the Test module is use()ed here so read
  1816. # its man page ( perldoc Test ) for help writing this test script.
  1817.  
  1818. _END_
  1819. close(EX) || die "Can't close $ext$modpname/test.pl: $!\n";
  1820.  
  1821. unless ($opt_C) {
  1822.   warn "Writing $ext$modpname/Changes\n";
  1823.   $" = ' ';
  1824.   open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n";
  1825.   @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS;
  1826.   print EX <<EOP;
  1827. Revision history for Perl extension $module.
  1828.  
  1829. $TEMPLATE_VERSION  @{[scalar localtime]}
  1830. \t- original version; created by h2xs $H2XS_VERSION with options
  1831. \t\t@ARGS
  1832.  
  1833. EOP
  1834.   close(EX) || die "Can't close $ext$modpname/Changes: $!\n";
  1835. }
  1836.  
  1837. warn "Writing $ext$modpname/MANIFEST\n";
  1838. open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!";
  1839. my @files = <*>;
  1840. if (!@files) {
  1841.   eval {opendir(D,'.');};
  1842.   unless ($@) { @files = readdir(D); closedir(D); }
  1843. }
  1844. if (!@files) { @files = map {chomp && $_} `ls`; }
  1845. if ($^O eq 'VMS') {
  1846.   foreach (@files) {
  1847.     # Clip trailing '.' for portability -- non-VMS OSs don't expect it
  1848.     s%\.$%%;
  1849.     # Fix up for case-sensitive file systems
  1850.     s/$modfname/$modfname/i && next;
  1851.     $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes';
  1852.     $_ = 'Makefile.PL' if $_ eq 'makefile.pl';
  1853.   }
  1854. }
  1855. print MANI join("\n",@files), "\n";
  1856. close MANI;
  1857.  
  1858. __END__
  1859. :endofperl
  1860.